Krill SDK/krill.zone.shared.node

Package-level declarations

Types

interface ActionNodeMetaData : NodeMetaData

Extended contract for trigger and executor metadata that carries an explicit nodeAction discriminator.

Client-side processor contract: receives a node value emitted by the local state-flow observer and dispatches it to the UI layer.

DataSource

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class DataSource

DigitalState

@Serializable

enum DigitalState : Enum<DigitalState>

Binary state for nodes that represent a single on/off signal — typically GPIO pins and pin-backed abstractions (solenoids, relays, LEDs, buttons).

InvocationTrigger

enum InvocationTrigger : Enum<InvocationTrigger>

The set of events that can cause an executor / filter / trigger node to fire its work.

Node

@Serializable

data class Node(val id: String, val parent: String, val host: String, val type: KrillApp, val state: NodeState = NodeState.NONE, val meta: NodeMetaData, val timestamp: Long = 0)

A single node in a Krill swarm.

NodeAction

@Serializable

enum NodeAction : Enum<NodeAction>

The verb a trigger or executor node performs when it fires.

NodeBuilder

class NodeBuilder

Mutable builder for a single Node.

NodeHttp

class NodeHttp(clientProvider: () -> HttpClient, trustHost: TrustHost, bearerTokenProvider: () -> String?)

REST + SSE-friendly client for a Krill server.

NodeIdentity

@Serializable

data class NodeIdentity(val nodeId: String, val hostId: String)

Address pair that uniquely identifies a node in a multi-server Krill swarm.

NodeMetaData

interface NodeMetaData

Marker interface that every node's per-type metadata payload must implement.

NodeObserver

interface NodeObserver

Subscriber-and-dispatcher contract for the per-node state-flow streams.

NodeState

@Serializable

enum NodeState : Enum<NodeState>

Lifecycle / status state for every Krill node.

NodeWire

@Serializable

data class NodeWire(val timestamp: Long, val installId: String, host: String, val port: Int, val platform: Platform, val clusterToken: String = "")

The minimal payload required to discover and connect to a Krill peer.

PinPullResistance

@Serializable

enum PinPullResistance : Enum<PinPullResistance>

ServerNodeProcessor

interface ServerNodeProcessor

Server-side processor contract: receives a deliberate invocation and runs the node's execution logic.

SourceMetaData

interface SourceMetaData : ActionNodeMetaData

Common contract for nodes that read from upstream sources and write to downstream targets — the executor / filter / trigger family.

Functions

details

fun StateFlow<Node>.details(): String

Same as Node.details, lifted to operate on a StateFlow<Node> directly.

fun Node.details(): String

Renders a debug-friendly one-liner of the node — used in log lines to give the timestamp / type / display name / state in a compact form.

https

fun Node.https(): Url

Returns the canonical https://<resolvedHost>:<port> Url for a server node. Throws IllegalArgumentException with a diagnostic message when meta is not a ServerMetaData — prefer calling this only on nodes whose type is KrillApp.Server.

fun Node.id(): NodeIdentity

Returns this node's address pair — (nodeId, hostId) — as a NodeIdentity suitable for use inside SourceMetaData source / target lists.

isDigital

fun Node.isDigital(): Boolean

true when this node's value is inherently boolean / digital. Delegates to NodeMetaData.isDigital.

isInvokable

fun NodeState.isInvokable(): Boolean

Returns true when a node in this state may receive a deliberate invocation.

isMenuOption

fun KrillApp.isMenuOption(): Boolean

true when this KrillApp is a MenuCommand subtype rather than a real node type. Used to skip menu-command discriminators in iteration code that only cares about real swarm nodes.

key

fun Node.key(): String

Renders the node as a "<timestamp>:<id>" key. Used as a stable cache / comparison key in places where (timestamp, id) tuples need to be compared by value rather than by structural equality of the full node.

name

fun Node.name(): String

Returns the human-readable display name for the node. Delegates to NodeMetaData.displayName; when that returns empty, falls back to the node's KrillApp type string (the desired behaviour for MenuCommand entries and any subtype with no dedicated name field).

snapshotColorArgb

fun Node.snapshotColorArgb(): Long

For a DataPoint whose DataType is COLOR, returns the snapshot value parsed as a packed ARGB Long (0xFFRRGGBB). For any other node type or an unparseable value, returns opaque black (0xFF000000) so callers can unconditionally render the result without null-checking.

toDouble

fun DigitalState.toDouble(): Double

Maps DigitalState to a numeric value for graphing: ON → 1.0, OFF → 0.0.

updateMetaWithError

fun updateMetaWithError(meta: NodeMetaData, error: String): NodeMetaData

Returns a copy of meta with its error field replaced by error.

url

fun NodeWire.url(): String

Returns the canonical https://<host>:<port> URL for this peer's HTTP/SSE endpoint. Krill requires TLS on every interconnect, so the scheme is always https.